Service configuration
Click 'Service' in the left-hand menu to access all of these settings.
Service Settings
| Setting name | Description |
|---|---|
| Service address | The address of the IPS Server (either a single server machine, or the load balancer for a cluster) specified as a FQDN, DNS alias, or IP address. This setting is used by the IPS, PlanningSpace and SUITE cx configuration files. |
| Data source | The database that is being used as the IPS common database. |
| Authorized cluster group | The IPS service account must be a member of the specified local security group in order to be able to create or modify an IPS Server cluster. |
| Cluster servers | List of the IPS Server machines showing: FQDN, primary/secondary server status (primary if the box is ticked), the IPS version installed, and the status of the server. Allowed changes here are: set the primary server by ticking the box for a current secondary server; for a 'Running' machine there is a 'Switch to maintenance mode' control button, which will temporarily remove the machine from the cluster; a ‘Remove’ button will appear for machines with status 'Not Responding' or 'Stopped' - use this button to permanently remove a machine from the cluster. |
Endpoint settings
| Setting name | Description |
|---|---|
| Web Server: Use https | Tick this box to enable HTTPS for the IPS Server. See Setting up HTTPS (secure HTTP) for IPS Server. |
| Web Server: Use default port | Tick this box to use the default web port 80, or 443 if 'Use https' is enabled. |
| Web Server: Port | If the web port is not the default number (80 or 443), type in the port number. |
| Management: Monitor port | The server machine port used for monitor functions. Default is 81. Uses only HTTP and no user data is exposed on this port. |
| Cluster: Cluster port | The server machine port used for cluster management communications. Default is 82. |
Application ports
See IPS Server Application ports.
Diagnostics settings
The contents of log files can be configured with the settings in the following table.
Important: For an IPS Server cluser, log files are written separately on each server machine, based on the processes and events which occur only on that machine. There is no merging of log file content between the server machines.
| Setting name | Description |
|---|---|
| Main log level | The level of logging can be set to one of the following options (in order of increasing detail): Error, Warning, Info, Trace. The log file location is set for each server machine with the 'LogFolder' setting, in the 'Servers' screen, 'Advanced' section. |
| Event log level | The level of logging can be set to one of the following options (in order of increasing detail): Error, Warning, Info, Trace. These log messages appear in the Windows Event Viewer for each server machine. |
| Generate memory dump | If this box is checked, when an IPS server machine shuts down unexpectedly then a dump file will be written to the machine hard disk. The dump file location is set for each server machine with the 'DumpFolder' setting, in the 'Servers' screen, 'Advanced' section. |
Service certificate
The service certificate is required to enable secure HTTP (HTTPS) for the IPS Server, and therefore to have encrypted client-server communication for PlanningSpace and SUITE cx applications.
There is no default certificate provided.
For set-up instructions, see Setting up HTTPS (secure HTTP) for IPS Server.
Mail settings
Support address: This should be the email address for local technical support of the Palantir software deployment. A dummy value 'support@company.com' is set as default.
SMTP settings
These are connection settings for an optional SMTP server, so that IPS Server can send automated emails to administrators and users for diagnostic purposes, or as part of workflows configured in PlanningSpace client applications.
In the 'Server' field, enter the FQDN of the SMTP server, and enter the port number in 'Port'. Check the 'Secure connection (SSL/TLS)' checkbox if the SMTP server requires this.
The SMTP 'Username' must be given in UPN format (i.e., 'user@mycompany.com'). For anonymous SMTP, leave the username and password blank. The value of 'Send from email' will be used as the sender address for automated emails sent by IPS Server to users.
Use the 'Test' button to verify that the SMTP server connection is functional.
A Mail administrator in your organisation will be able to provide a username and password for the SMTP server, or make the necessary modifications to allow the IPS server machines to connect via anonymous SMTP.
Advanced settings
The following table details the settings, default values, and allowed values. You can re-order the settings on the screen by clicking the up/down arrows next to the 'Name' or 'Category' headings
Use the 'Edit' button to change a setting value.
Use the red 'Reset' button to change the setting to its default value.
| Setting name | Description | Default Value | Allowed values or range |
|---|---|---|---|
| Category: Connection Pool | |||
| Tenant Max Pool Size | The maximum number of connections allowed in the pool. | 100 | Integer 10 to 32767 |
| Tenant Connection Lifetime | When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if the time difference (in seconds) exceeds the value specified by Tenant Connection Lifetime. This is useful in clustered configurations to force load balancing between a running server and a server just brought online. A zero value ('0') will cause pooled connections to have the maximum time-out. | 0 | 0 to 2^31 |
| Category: Notification | |||
| Certificate Expiration Notice Period | Starting from the specified number of days before the certificate expiry date, an expiry warning will appear in the IPS Manager. | 180 | 0 to 365 |
| Log Level | Notification log level. | Info | Error, Warning, Info, Trace |
| Subscription Timeout Period | Period in minutes before closing the session of an inactive client. | 5 | 5 to 10 |
| Category: Proxy | |||
| Use System Default | If set to True, the Internet Explorer proxy settings will be overridden with the values specified by the IPS 'Proxy' settings. | None | Boolean or None |
| Enable Proxy | If set to True then a web proxy will be used. | True | Boolean |
| Custom Proxy Address | The URL address of the proxy. | None | URL |
| Custom Bypass On Local | If set to True, the proxy will be by-passed for local resources. Local resources include the local server (http://localhost, http://loopback, http://127.0.0.1) and a URL without a period (for example http://webserver). | None | Boolean or None |
| Add IPS Server To Global Proxy Bypass List | If set to True, the PlanningSpace client application will directly access IPS server resources and it will not check the system default proxy settings, or the custom proxy settings. | False | Boolean |
| Category: Request processing | |||
| Session Idle Timeout | Interval in minutes to wait before closing a distributed compute session with no active request. | 5 | 2 to 120 |
| Category: Scheduler | |||
| Job History | Number of days that the output of a completed batch job or server task will be stored in the database. | 7 | Integer 2 to 30 |
| Category: Security | |||
| Allowed Api Key Names | Comma-delimited list of 'usernames' that will be allowed to submit requests to the PlanningSpace APIs with an API key used as the 'password'. | FeedKey,AccountKey | Comma-delimited list or blank |
| Allowed URLs For Cross Origin Requests | Comma-delimited URL whitelist for cross-origin requests to this IPS Server (used to allow connection from add-in tools such as the PlanningSpace Data Connector for Excel). Include the port number if not 80 or 443. If the 'Use https' setting is enabled, only secure URLs will be used. Example: "https://exceladdin.planningspace.com,https://dataconnector.planningspace.com" | None | URL with protocol and FQDN, DNS alias or IP address |
| Category: Server Monitor | |||
| Monitor History | Number of days of Server Monitor historical data that will be stored in the database. | 30 | Integer 2 to 30 |
| Sampling Interval | Time interval in seconds for sampling the performance monitors to provide data to the Server Monitor web application. | 30 | Integer 5 to 120 |
| Category: Timeouts and Intervals | |||
| Cluster Server Check Failure Threshold | Number of consecutive server check failures before setting a server to status 'Not Responding'. | 3 | Integer 3 to 20 |
| Cluster Rejoin Interval | Interval in minutes before a server attempts to rejoin the cluster. | 5 | 2 to 60 |
| Cluster Server Check Interval | Interval in seconds between checks of the availability of a peer server. | 30 | 5 to 60 |
| Cluster Server Connection Timeout | Period in seconds before an attempt to open a connection to a peer server times out. | 30 | 5 to 60 |
| Cluster Server Operation Timeout | Period in seconds before a service call to a peer server times out. | 600 | 60 to 1200 |
| Data Source Check Failure Threshold | Number of consecutive data source check failures before a server disconnects from the cluster. The server will then attempt to rejoin the cluster after the time period specified by Cluster Rejoin Interval. | 3 | Integer 3 to 20 |
| Data Source Check Interval | Interval in seconds before checking the availability of the IPS common data source (the common database). | 10 | 5 to 60 |
| Maintenance Mode Wait Period | Period in seconds before a server machine goes into maintenance mode following the Administrator's request. The wait period will begin after the monitor port has been stopped, and must therefore be longer than the health check interval for this server which is set on the load balancer. | 10 | 2 to 120 |
| Shutdown Timeout Period | Timeout period in seconds before the IPS server terminates, after receiving a shutdown request. | 15 | 10 to 60 |
| Tenant Unload Period | Period in seconds before completely unloading a tenant when there is a data source change. | 30 | 10 to 60 |